Einhugur Xml Plugin for Xojo

EinhugurXml Module

EinhugurXml

module EinhugurXml

Methods

CreateInstanceOfUnknownClassHelper function for Xml Serialization framework.

Enumerations

NodeTypeEnum representing node types.
ParsingStatusError code for Parse results.
XPathTypeXPath value type codes for use with XPath variables.

Constants

Version = 1.0Version of the plugin.
FORMAT_INDENT = &h01Format constants should be used as optional parameter with the SaveToFile and ToString functions on the Document class.

When using Format flags you start with the EinhugurXml.FORMAT_DEFAULT and then or other flags to it. (or use and not to turn off the FORMAT_INDENT which is on by default in the default setting).

Example:

var myFlags as Integer = EinhugurXml.FORMAT_DEFAULT or EinhugurXml.FORMAT_NO_ESCAPES



or if wanting to switch off flag that is on:

var myFlags as Integer = EinhugurXml.FORMAT_DEFAULT and not EinhugurXml.FORMAT_INDENT



The FORMAT_INDENT flag:
Determines if all nodes should be indented with the indentation string. If this flag is on, the indentation string is printed several times before every node, where the amount of indentation depends on the node’s depth relative to the output subtree. This flag has no effect if FORMAT_RAW is enabled. This flag is on by default.
FORMAT_WRITE_BOM = &h02Format constants should be used as optional parameter with the SaveToFile and ToString functions on the Document class.

When using Format flags you start with the EinhugurXml.FORMAT_DEFAULT and then or other flags to it. (or use and not to turn off the FORMAT_INDENT which is on by default in the default setting).

Example:

var myFlags as Integer = EinhugurXml.FORMAT_DEFAULT or EinhugurXml.FORMAT_NO_ESCAPES



or if wanting to switch off flag that is on:

var myFlags as Integer = EinhugurXml.FORMAT_DEFAULT and not EinhugurXml.FORMAT_INDENT



The FORMAT_WRITE_BOM flag:
Enables Byte Order Mark (BOM) output. By default, no BOM is output, so in case of non UTF-8 encodings the resulting document’s encoding may not be recognized by some parsers and text editors, if they do not implement sophisticated encoding detection. Enabling this flag adds an encoding-specific BOM to the output. ToString functions on Nodes (as opposed to ToString functions on Document) they never output the BOM. This flag is off by default.
FORMAT_RAW = &h04Format constants should be used as optional parameter with the SaveToFile and ToString functions on the Document class.

When using Format flags you start with the EinhugurXml.FORMAT_DEFAULT and then or other flags to it. (or use and not to turn off the FORMAT_INDENT which is on by default in the default setting).

Example:

var myFlags as Integer = EinhugurXml.FORMAT_DEFAULT or EinhugurXml.FORMAT_NO_ESCAPES



or if wanting to switch off flag that is on:

var myFlags as Integer = EinhugurXml.FORMAT_DEFAULT and not EinhugurXml.FORMAT_INDENT



The FORMAT_RAW flag:
Switches between formatted and raw output. If this flag is on, the nodes are not indented in any way, and also no newlines that are not part of document text are printed. Raw mode can be used for serialization where the result is not intended to be read by humans. This flag is off by default.
FORMAT_NO_DECLARATION = &h08Format constants should be used as optional parameter with the SaveToFile and ToString functions on the Document class.

When using Format flags you start with the EinhugurXml.FORMAT_DEFAULT and then or other flags to it. (or use and not to turn off the FORMAT_INDENT which is on by default in the default setting).

Example:

var myFlags as Integer = EinhugurXml.FORMAT_DEFAULT or EinhugurXml.FORMAT_NO_ESCAPES



or if wanting to switch off flag that is on:

var myFlags as Integer = EinhugurXml.FORMAT_DEFAULT and not EinhugurXml.FORMAT_INDENT



The FORMAT_NO_DECLARATION flag:
Disables default node declaration output. By default, if the document is saved via SaveToFile function or ToString function on Document, and it does not have any document declaration, a default declaration is output before the document contents. Enabling this flag disables this declaration. This flag has no effect in ToString functions on Nodes: they never output the default declaration. This flag is off by default.
FORMAT_NO_ESCAPES = &h10Format constants should be used as optional parameter with the SaveToFile and ToString functions on the Document class.

When using Format flags you start with the EinhugurXml.FORMAT_DEFAULT and then or other flags to it. (or use and not to turn off the FORMAT_INDENT which is on by default in the default setting).

Example:

var myFlags as Integer = EinhugurXml.FORMAT_DEFAULT or EinhugurXml.FORMAT_NO_ESCAPES



or if wanting to switch off flag that is on:

var myFlags as Integer = EinhugurXml.FORMAT_DEFAULT and not EinhugurXml.FORMAT_INDENT



The FORMAT_NO_ESCAPES flag:
Disables output escaping for attribute values and PCDATA contents. If this flag is off, special symbols (", &, <, >) and all non-printable characters (those with codepoint values less than 32) are converted to XML escape sequences (i.e. &) during output. If this flag is on, no text processing is performed; therefore, output XML can be malformed if output contents contains invalid symbols (i.e. having a stray < in the PCDATA will make the output malformed). This flag is off by default.
FORMAT_SAVE_FILE_TEXT = &h20Format constants should be used as optional parameter with the SaveToFile and ToString functions on the Document class.

When using Format flags you start with the EinhugurXml.FORMAT_DEFAULT and then or other flags to it. (or use and not to turn off the FORMAT_INDENT which is on by default in the default setting).

Example:

var myFlags as Integer = EinhugurXml.FORMAT_DEFAULT or EinhugurXml.FORMAT_NO_ESCAPES



or if wanting to switch off flag that is on:

var myFlags as Integer = EinhugurXml.FORMAT_DEFAULT and not EinhugurXml.FORMAT_INDENT



The FORMAT_SAVE_FILE_TEXT flag:
Changes the file mode when using save_file function. By default, file is opened in binary mode, which means that the output file will contain platform-independent newline \n (ASCII 10). If this flag is on, file is opened in text mode, which on some systems changes the newline format (i.e. on Windows you can use this flag to output XML documents with \r\n (ASCII 13 10) newlines. This flag is off by default.
FORMAT_INDENT_ATTRIBUTES = &h40Format constants should be used as optional parameter with the SaveToFile and ToString functions on the Document class.

When using Format flags you start with the EinhugurXml.FORMAT_DEFAULT and then or other flags to it. (or use and not to turn off the FORMAT_INDENT which is on by default in the default setting).

Example:

var myFlags as Integer = EinhugurXml.FORMAT_DEFAULT or EinhugurXml.FORMAT_NO_ESCAPES



or if wanting to switch off flag that is on:

var myFlags as Integer = EinhugurXml.FORMAT_DEFAULT and not EinhugurXml.FORMAT_INDENT



The FORMAT_INDENT_ATTRIBUTES flag:
Determines if all attributes should be printed on a new line, indented with the indentation string according to the attribute’s depth. This flag implies FORMAT_INDENT. This flag has no effect if FORMAT_RAW is enabled. This flag is off by default.
FORMAT_NO_EMPTY_ELEMENT_TAGS = &h80Format constants should be used as optional parameter with the SaveToFile and ToString functions on the Document class.

When using Format flags you start with the EinhugurXml.FORMAT_DEFAULT and then or other flags to it. (or use and not to turn off the FORMAT_INDENT which is on by default in the default setting).

Example:

var myFlags as Integer = EinhugurXml.FORMAT_DEFAULT or EinhugurXml.FORMAT_NO_ESCAPES



or if wanting to switch off flag that is on:

var myFlags as Integer = EinhugurXml.FORMAT_DEFAULT and not EinhugurXml.FORMAT_INDENT



The FORMAT_NO_EMPTY_ELEMENT_TAGS flag:
Determines if start/end tags should be output instead of empty element tags for empty elements (that is, elements with no children). This flag is off by default.
FORMAT_SKIP_CONTROL_CHARS = &h100Format constants should be used as optional parameter with the SaveToFile and ToString functions on the Document class.

When using Format flags you start with the EinhugurXml.FORMAT_DEFAULT and then or other flags to it. (or use and not to turn off the FORMAT_INDENT which is on by default in the default setting).

Example:

var myFlags as Integer = EinhugurXml.FORMAT_DEFAULT or EinhugurXml.FORMAT_NO_ESCAPES



or if wanting to switch off flag that is on:

var myFlags as Integer = EinhugurXml.FORMAT_DEFAULT and not EinhugurXml.FORMAT_INDENT



The FORMAT_SKIP_CONTROL_CHARS flag:
Enables skipping characters belonging to range [0; 32) instead of "&#xNN;" encoding. This flag is off by default.
FORMAT_ATTRIBUTE_SINGLE_QUOTE = &h200Format constants should be used as optional parameter with the SaveToFile and ToString functions on the Document class.

When using Format flags you start with the EinhugurXml.FORMAT_DEFAULT and then or other flags to it. (or use and not to turn off the FORMAT_INDENT which is on by default in the default setting).

Example:

var myFlags as Integer = EinhugurXml.FORMAT_DEFAULT or EinhugurXml.FORMAT_NO_ESCAPES



or if wanting to switch off flag that is on:

var myFlags as Integer = EinhugurXml.FORMAT_DEFAULT and not EinhugurXml.FORMAT_INDENT



The FORMAT_ATTRIBUTE_SINGLE_QUOTE flag:
Enables using single quotes ' instead of double quotes " for enclosing attribute values. This flag is off by default.
FORMAT_DEFAULT = &h01Format constants should be used as optional parameter with the SaveToFile and ToString functions on the Document class.

When using Format flags you start with the EinhugurXml.FORMAT_DEFAULT and then or other flags to it. (or use and not to turn off the FORMAT_INDENT which is on by default in the default setting).

Example:

var myFlags as Integer = EinhugurXml.FORMAT_DEFAULT or EinhugurXml.FORMAT_NO_ESCAPES



or if wanting to switch off flag that is on:

var myFlags as Integer = EinhugurXml.FORMAT_DEFAULT and not EinhugurXml.FORMAT_INDENT



The FORMAT_ATTRIBUTE_SINGLE_QUOTE flag:
Is the default set of flags, i.e. it has all options set to their default values. It sets formatted output with indentation, without BOM and with default node declaration, if necessary.